.Dd March, 10 2025
.Dt PIXIV_DOWN 1
.Os
.Sh NAME
.Nm pixiv_down
.Nd command line downloader for
.Lk www.pixiv.net
.Sh SYNOPSIS
.Nm
.Ar command
.Op options
.Sh DESCRIPTION
.Nm
is a command line program that allows you to download various content
from the pixiv website.  It allows you to download specific artworks
with the
.Cm artwork
command; download all of the works uploaded by a particular artist
with the
.Cm artist
command; download all of the works uploaded by all the artists you
follow with the
.Cm following
command; download all of the works uploaded by all the artists you
follow between certain dates with the
.Cm daily
command.
.Pp
.Nm
supports downloading the following content types:
.Bl -bullet -compact
.It
Illustrations
.It
Manga
.It
Novels
.It
Ugoira
.El
.Ss Options
.Bl -tag -width Ds
.It Fl h, \-help
Print the synopsis and a list of the commands.
.It Fl v, \-version
Prints the version of
.Nm ,
potentially followed by a reference of the version control commit
hash.  The output is generated by
.Xr git-describe 1 .
.It Fl \-converter
Specify the converter plugin to use when downloading Ugoira and creating
animated images.  Setting the value here will override any values set in any
configuration file, including ones specified with
.Fl \-config-file .
.It Fl \-config-file
Provide a custom path for the configuration file used for this instance.  See
.Xr pixiv_down.conf 5
for more file information.
.It Fl \-output-directory
Specify a custom base directory to use when downloading artworks.  Setting
the value here will override any values set in any configuration file,
including ones specified with
.Fl \-config-file .
.El
.Ss Commands
.Bl -tag
.It Xr pixiv_down-artist 1
Download all the content uploaded by an artist.
.It Xr pixiv_down-artwork 1
Download specific artworks, including manga, by their ID.
.It Xr pixiv_down-bookmarked 1
Download bookmarked works, optionally removing works that no
longer exist.
.It Xr pixiv_down-compact 1
Compact all of an artist's directories in to one.
.It Xr pixiv_down-daily 1
Download all content by followed artists between dates.
.It Xr pixiv_down-errors 1
Print the work ID of all works that have failed to download.
.It Xr pixiv_down-following 1
Download all content by followed artists.
.It Xr pixiv_down-novel 1
Download specific novels by their ID.
.It Xr pixiv_down-prune 1
Remove previously downloaded content by artists that are no
longer followed or no longer exist.
.El
.Sh ENVIRONMENT
.Bl -tag -width PIXIV_DOWN_LOG_LEVELX
.It Ev PIXIV_DOWN_LOG_LEVEL
Controls the log verbosity for logging events to the
.Pa pixiv_down.log
file.
.It Ev PIXIV_DOWN_SESSID
The value of the
.Va PHPSESSID
cookie taken from the pixiv website.  This value will take
precedence over any previously stored value.
.El
.Sh FILES
.Bl -tag -width $XDG_CONFIG_HOME/pixiv_down/pixiv_down.conf
.It Pa $XDG_CONFIG_HOME/pixiv_down/pixiv_down.conf
configuration file.  If
.Ev XDG_CONFIG_HOME
is not set, then the fallback is
.Pa $HOME/.config .
.El
.Sh SEE ALSO
.Xr pixiv_down.conf 5
.Sh AUTHORS
Written by
.An Mio Aq stigma@disroot.org
.Sh BUGS
.Pp
Please report any bugs you may find at the bug tracker, which can be
found on the website at
.Lk https://yume-neru.neocities.org/p/pixiv_down.html
